/*
 * Javlov - a Java toolkit for reinforcement learning with multi-agent support.
 * 
 * Copyright (c) 2009 Matthijs Snel
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package net.javlov;

import java.util.HashMap;
import java.util.Map;

public abstract class AbstractOption implements Option {

	private static int counter = 0;
	private int id;
	
	protected boolean finished = false;
	protected String name;

	protected Map<State, Double> betas;
	
	protected AbstractOption() {
		this(null);
		setName(getClass().getName());
	}

	protected AbstractOption(String name) {
		id = counter++;
		setName(name);
		betas = new HashMap<State, Double>();
	}
	
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	/**
	 * @inheritDoc
	 */
	@Override
	public int getID() {
		return id;
	}

	/**
	 * Indicates whether this option is eligible (can be initiated) in state
	 * {@code s}.
	 * 
	 * If no beta has been set for {@code s}, this method returns false. Otherwise, it
	 * returns the boolean {@code beta < 1}.
	 * 
	 * @param s the state
	 * @return {@code (beta != null && beta < 1)}
	 */
	@Override
	public <T> boolean isEligible(State<T> s) {
		Double beta = betas.get(s);
		return (beta != null && beta < 1);
	}

	@Override
	public <T> void setBeta(State<T> s, double beta) {
		if ( beta < 0 || beta > 1 )
			throw new IllegalArgumentException("Beta must be between 0 and 1: " + beta);
		betas.put(s, beta);
	}
	
	@Override
	public void setFinished() {
		finished = true;
	}

	/**
	 * @inheritDoc
	 */
	@Override
	public void setID(int id) {
		this.id = id;
	}

	/**
	 * Does nothing.
	 */
	@Override
	public void init() {}

	/**
	 * Does nothing.
	 */
	@Override
	public void reset() {}


	@Override
	public String toString() {
		return name;
	}

	@Override
	public boolean isFinished() {
		return finished;
	}
	
	@Override
	public boolean equals(Object o) {
		if ( o == null || !(o instanceof AbstractOption) )
			return false;
		return id == ((AbstractOption)o).id;
	}
	
	@Override
	public int hashCode() {
		return id;
	}

}